Inside Macintosh: QuickDraw GX Graphics /

Chapter 2 - Geometric Shapes / Geometric Shapes Reference

Functions / Getting and Setting Shape Geometries

GXGetLine

You can use the GXGetLine function to determine the geometry of an existing line shape.

gxLine *GXGetLine(gxShape source, gxLine *data);

source

A reference to the line shape whose geometry you want to determine.

data

A pointer to a gxLine structure. The function copies the source shape's geometry into this structure.

function result

A pointer to a copy of the source shape's geometry.

DESCRIPTION

The GXGetLine function copies the geometry information from the source line shape into the gxLine structure pointed to by the data parameter. As a convenience, this function also returns a pointer to the line geometry as the function result.

If the source shape is not a line shape, this function posts the error code illegal_type_for_shape.

You must pass a pointer to a gxLine structure in the data parameter--if you pass nil for this parameter, the function posts the error code parameter_is_nil.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
illegal_type_for_shape	(debugging version)
parameter_is_nil	(debugging version)

SEE ALSO

For general information about line geometries, see "Line Shapes" on page 2-17.

For the definition of the gxLine structure, see page 2-105.

To create a new line shape, use the GXNewLine function, which is described on page 2-112.

To change the geometry of an existing line shape, use the GXSetLine function, which is described in the next section.

To draw a line geometry without creating a line shape, use the GXDrawLine function, which is described on page 2-158. To draw a line shape, use the GXDrawShape function, which is described in the chapter "Shape Objects" in Inside Macintosh: QuickDraw GX Objects.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help